home *** CD-ROM | disk | FTP | other *** search
/ Revista do CD-ROM 118 / cd-rom 118.iso / aplic / open / openofficeorg1.cab / sbasic.jar / text / sbasic / shared / 03080701.xhp < prev    next >
Encoding:
Extensible Markup Language  |  2005-02-14  |  6.3 KB  |  126 lines
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--***********************************************************************
  3.  *
  4.  *  The Contents of this file are made available subject to the terms of
  5.  *  either of the following licenses
  6.  *
  7.  *         - GNU Lesser General Public License Version 2.1
  8.  *         - Sun Industry Standards Source License Version 1.1
  9.  *
  10.  *  Sun Microsystems Inc., October, 2000
  11.  *
  12.  *  GNU Lesser General Public License Version 2.1
  13.  *  =============================================
  14.  *  Copyright 2000 by Sun Microsystems, Inc.
  15.  *  901 San Antonio Road, Palo Alto, CA 94303, USA
  16.  *
  17.  *  This library is free software; you can redistribute it and/or
  18.  *  modify it under the terms of the GNU Lesser General Public
  19.  *  License version 2.1, as published by the Free Software Foundation.
  20.  *
  21.  *  This library is distributed in the hope that it will be useful,
  22.  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  23.  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  24.  *  Lesser General Public License for more details.
  25.  *
  26.  *  You should have received a copy of the GNU Lesser General Public
  27.  *  License along with this library; if not, write to the Free Software
  28.  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  29.  *  MA  02111-1307  USA
  30.  *
  31.  *
  32.  *  Sun Industry Standards Source License Version 1.1
  33.  *  =================================================
  34.  *  The contents of this file are subject to the Sun Industry Standards
  35.  *  Source License Version 1.1 (the "License"); You may not use this file
  36.  *  except in compliance with the License. You may obtain a copy of the
  37.  *  License at http://www.openoffice.org/license.html.
  38.  *
  39.  *  Software provided under this License is provided on an "AS IS" basis,
  40.  *  WITHOUT WARRUNTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING,
  41.  *  WITHOUT LIMITATION, WARRUNTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
  42.  *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
  43.  *  See the License for the specific provisions governing your rights and
  44.  *  obligations concerning the Software.
  45.  *
  46.  *  The Initial Developer of the Original Code is: Sun Microsystems, Inc..
  47.  *
  48.  *  Copyright: 2000 by Sun Microsystems, Inc.
  49.  *
  50.  *  All Rights Reserved.
  51.  *
  52.  *  Contributor(s): _______________________________________
  53.  *
  54.  *
  55.  ************************************************************************-->
  56.     
  57. <helpdocument version="1.0">
  58. <meta>
  59. <topic id="textsbasicshared03080701xml" indexer="include" status="PUBLISH">
  60. <title id="tit" xml-lang="en-US">Sgn Function [Runtime]</title>
  61. <filename>/text/sbasic/shared/03080701.xhp</filename>
  62. </topic>
  63. <history>
  64. <created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
  65. <lastedited date="2004-08-24T14:24:24">converted from old format - fpe</lastedited>
  66. </history>
  67. </meta>
  68. <body>
  69. <section id="sgn">
  70. <bookmark xml-lang="en-US" branch="index" id="bm_id3148474"><bookmark_value>Sgn function</bookmark_value>
  71. </bookmark>
  72. <paragraph role="heading" id="hd_id3148474" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03080701.xhp" name="Sgn Function [Runtime]">Sgn Function [Runtime]</link></paragraph>
  73. <paragraph role="paragraph" id="par_id3148686" xml-lang="en-US" l10n="U" oldref="2">Returns an integer number between -1 and 1 that indicates if the number that is passed to the function is positive, negative, or zero.</paragraph>
  74. </section>
  75. <paragraph role="heading" id="hd_id3156023" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
  76. <paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="4">Sgn (Number)</paragraph>
  77. <paragraph role="heading" id="hd_id3145069" xml-lang="en-US" level="2" l10n="U" oldref="5">Return value:</paragraph>
  78. <paragraph role="paragraph" id="par_id3150359" xml-lang="en-US" l10n="U" oldref="6">Integer</paragraph>
  79. <paragraph role="heading" id="hd_id3150543" xml-lang="en-US" level="2" l10n="U" oldref="7">Parameters:</paragraph>
  80. <paragraph role="paragraph" id="par_id3154365" xml-lang="en-US" l10n="U" oldref="8">
  81. <emph>Number:</emph> Numeric expression that determines the value that is returned by the function.</paragraph>
  82. <table id="tbl_id3156281">
  83. <tablerow>
  84. <tablecell colspan="" rowspan="">
  85. <paragraph role="paragraph" id="par_id3150767" xml-lang="en-US" l10n="U" oldref="9">NumExpression</paragraph>
  86. </tablecell>
  87. <tablecell colspan="" rowspan="">
  88. <paragraph role="paragraph" id="par_id3150441" xml-lang="en-US" l10n="U" oldref="10">Return value</paragraph>
  89. </tablecell>
  90. </tablerow>
  91. <tablerow>
  92. <tablecell colspan="" rowspan="">
  93. <paragraph role="paragraph" id="par_id3161833" xml-lang="en-US" l10n="U" oldref="11">negative</paragraph>
  94. </tablecell>
  95. <tablecell colspan="" rowspan="">
  96. <paragraph role="paragraph" id="par_id3155306" xml-lang="en-US" l10n="U" oldref="12">Sgn returns -1.</paragraph>
  97. </tablecell>
  98. </tablerow>
  99. <tablerow>
  100. <tablecell colspan="" rowspan="">
  101. <paragraph role="paragraph" id="par_id3145271" xml-lang="en-US" l10n="U" oldref="13">0</paragraph>
  102. </tablecell>
  103. <tablecell colspan="" rowspan="">
  104. <paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="14">Sgn returns 0.</paragraph>
  105. </tablecell>
  106. </tablerow>
  107. <tablerow>
  108. <tablecell colspan="" rowspan="">
  109. <paragraph role="paragraph" id="par_id3153139" xml-lang="en-US" l10n="U" oldref="15">positive</paragraph>
  110. </tablecell>
  111. <tablecell colspan="" rowspan="">
  112. <paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U" oldref="16">Sgn returns 1.</paragraph>
  113. </tablecell>
  114. </tablerow>
  115. </table>
  116. <embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
  117. <embed href="text/sbasic/shared/00000003.xhp#err5"/>
  118. <paragraph role="heading" id="hd_id3152576" xml-lang="en-US" level="2" l10n="U" oldref="17">Example:</paragraph>
  119. <paragraph role="paragraph" id="par_id3154791" xml-lang="en-US" l10n="U" oldref="18">Sub ExampleSgn</paragraph>
  120. <paragraph role="paragraph" id="par_id3155416" xml-lang="en-US" l10n="U" oldref="19">Print sgn(-10) REM returns -1</paragraph>
  121. <paragraph role="paragraph" id="par_id3154096" xml-lang="en-US" l10n="U" oldref="20">Print sgn(0) REM returns 0</paragraph>
  122. <paragraph role="paragraph" id="par_id3148457" xml-lang="en-US" l10n="U" oldref="21">Print sgn(10) REM returns 1</paragraph>
  123. <paragraph role="paragraph" id="par_id3144765" xml-lang="en-US" l10n="U" oldref="22">end sub</paragraph>
  124. </body>
  125. </helpdocument>
  126.